Autogenerated HTML docs for v1.7.4
diff --git a/technical/api-allocation-growing.html b/technical/api-allocation-growing.html index fbbaad4..43e45d9 100644 --- a/technical/api-allocation-growing.html +++ b/technical/api-allocation-growing.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>allocation growing API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>allocation growing API</title> </head> <body> <div id="header"> @@ -311,9 +388,9 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Dynamically growing an array using realloc() is error prone and boring.</p></div> -<div class="para"><p>Define your array with:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Dynamically growing an array using realloc() is error prone and boring.</p></div> +<div class="paragraph"><p>Define your array with:</p></div> +<div class="ulist"><ul> <li> <p> a pointer (<tt>ary</tt>) that points at the array, initialized to <tt>NULL</tt>; @@ -332,7 +409,7 @@ </p> </li> </ul></div> -<div class="para"><p>Then before adding <tt>n`th element to the array, call `ALLOC_GROW(ary, n, +<div class="paragraph"><p>Then before adding <tt>n`th element to the array, call `ALLOC_GROW(ary, n, alloc)</tt>. This ensures that the array can hold at least <tt>n</tt> elements by calling <tt>realloc(3)</tt> and adjusting <tt>alloc</tt> variable.</p></div> <div class="listingblock"> @@ -349,12 +426,12 @@ ALLOC_GROW(ary, nr + 1, alloc); ary[nr++] = value you like;</tt></pre> </div></div> -<div class="para"><p>You are responsible for updating the <tt>nr</tt> variable.</p></div> +<div class="paragraph"><p>You are responsible for updating the <tt>nr</tt> variable.</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:09 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-builtin.html b/technical/api-builtin.html index 9ca7970..0fbbd8a 100644 --- a/technical/api-builtin.html +++ b/technical/api-builtin.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>builtin API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>builtin API</title> </head> <body> <div id="header"> @@ -311,9 +388,9 @@ </div> <h2 id="_adding_a_new_built_in">Adding a new built-in</h2> <div class="sectionbody"> -<div class="para"><p>There are 4 things to do to add a built-in command implementation to +<div class="paragraph"><p>There are 4 things to do to add a built-in command implementation to git:</p></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> Define the implementation of the built-in command <tt>foo</tt> with @@ -338,9 +415,9 @@ <div class="content"> <pre><tt>{ "foo", cmd_foo, <options> },</tt></pre> </div></div> -<div class="para"><p>where options is the bitwise-or of:</p></div> -<div class="vlist"><dl> -<dt> +<div class="paragraph"><p>where options is the bitwise-or of:</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>RUN_SETUP</tt> </dt> <dd> @@ -351,7 +428,7 @@ done. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>USE_PAGER</tt> </dt> <dd> @@ -360,7 +437,7 @@ feed our output to it. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>NEED_WORK_TREE</tt> </dt> <dd> @@ -378,8 +455,8 @@ </p> </li> </ol></div> -<div class="para"><p>Additionally, if <tt>foo</tt> is a new command, there are 3 more things to do:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>Additionally, if <tt>foo</tt> is a new command, there are 3 more things to do:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> Add tests to <tt>t/</tt> directory. @@ -399,21 +476,21 @@ </div> <h2 id="_how_a_built_in_is_called">How a built-in is called</h2> <div class="sectionbody"> -<div class="para"><p>The implementation <tt>cmd_foo()</tt> takes three parameters, <tt>argc</tt>, <tt>argv, +<div class="paragraph"><p>The implementation <tt>cmd_foo()</tt> takes three parameters, <tt>argc</tt>, <tt>argv, and `prefix</tt>. The first two are similar to what <tt>main()</tt> of a standalone command would be called with.</p></div> -<div class="para"><p>When <tt>RUN_SETUP</tt> is specified in the <tt>commands[]</tt> table, and when you +<div class="paragraph"><p>When <tt>RUN_SETUP</tt> is specified in the <tt>commands[]</tt> table, and when you were started from a subdirectory of the work tree, <tt>cmd_foo()</tt> is called after chdir(2) to the top of the work tree, and <tt>prefix</tt> gets the path to the subdirectory the command started from. This allows you to convert a user-supplied pathname (typically relative to that directory) to a pathname relative to the top of the work tree.</p></div> -<div class="para"><p>The return value from <tt>cmd_foo()</tt> becomes the exit status of the +<div class="paragraph"><p>The return value from <tt>cmd_foo()</tt> becomes the exit status of the command.</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:09 UTC +Last updated 2009-04-28 09:29:23 UTC </div> </div> </body> diff --git a/technical/api-decorate.html b/technical/api-decorate.html index ff2ba20..fc5ff10 100644 --- a/technical/api-decorate.html +++ b/technical/api-decorate.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>decorate API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>decorate API</title> </head> <body> <div id="header"> @@ -311,13 +388,13 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <decorate.h></p></div> -<div class="para"><p>(Linus)</p></div> +<div class="paragraph"><p>Talk about <decorate.h></p></div> +<div class="paragraph"><p>(Linus)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:09 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-diff.html b/technical/api-diff.html index 0dd1cf1..243ffd7 100644 --- a/technical/api-diff.html +++ b/technical/api-diff.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>diff API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>diff API</title> </head> <body> <div id="header"> @@ -311,13 +388,13 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The diff API is for programs that compare two sets of files (e.g. two +<div class="paragraph"><p>The diff API is for programs that compare two sets of files (e.g. two trees, one tree and the index) and present the found difference in various ways. The calling program is responsible for feeding the API pairs of files, one from the "old" set and the corresponding one from "new" set, that are different. The library called through this API is called diffcore, and is responsible for two things.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> finding total rewrites (<tt>-B</tt>), renames (<tt>-M</tt>) and copies (<tt>-C</tt>), and @@ -335,7 +412,7 @@ </div> <h2 id="_calling_sequence">Calling sequence</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> Prepare <tt>struct diff_options</tt> to record the set of diff options, and @@ -382,44 +459,44 @@ </div> <h2 id="_data_structures">Data structures</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct diff_filespec</tt> </p> </li> </ul></div> -<div class="para"><p>This is the internal representation for a single file (blob). It -records the blob object name (if known — for a work tree file it +<div class="paragraph"><p>This is the internal representation for a single file (blob). It +records the blob object name (if known — for a work tree file it typically is a NUL SHA-1), filemode and pathname. This is what the <tt>diff_addremove()</tt>, <tt>diff_change()</tt> and <tt>diff_unmerged()</tt> synthesize and feed <tt>diff_queue()</tt> function with.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct diff_filepair</tt> </p> </li> </ul></div> -<div class="para"><p>This records a pair of <tt>struct diff_filespec</tt>; the filespec for a file +<div class="paragraph"><p>This records a pair of <tt>struct diff_filespec</tt>; the filespec for a file in the "old" set (i.e. preimage) is called <tt>one</tt>, and the filespec for a file in the "new" set (i.e. postimage) is called <tt>two</tt>. A change that represents file creation has NULL in <tt>one</tt>, and file deletion has NULL in <tt>two</tt>.</p></div> -<div class="para"><p>A <tt>filepair</tt> starts pointing at <tt>one</tt> and <tt>two</tt> that are from the same +<div class="paragraph"><p>A <tt>filepair</tt> starts pointing at <tt>one</tt> and <tt>two</tt> that are from the same filename, but <tt>diffcore_std()</tt> can break pairs and match component filespecs with other filespecs from a different filepair to form new filepair. This is called <em>rename detection</em>.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct diff_queue</tt> </p> </li> </ul></div> -<div class="para"><p>This is a collection of filepairs. Notable members are:</p></div> -<div class="vlist"><dl> -<dt> +<div class="paragraph"><p>This is a collection of filepairs. Notable members are:</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>queue</tt> </dt> <dd> @@ -428,7 +505,7 @@ dynamically grows as you add filepairs; </p> </dd> -<dt> +<dt class="hdlist1"> <tt>alloc</tt> </dt> <dd> @@ -436,14 +513,14 @@ The allocated size of the <tt>queue</tt> array; </p> </dd> -<dt> +<dt class="hdlist1"> <tt>nr</tt> </dt> <dd> <p> The number of elements in the <tt>queue</tt> array. </p> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct diff_options</tt> @@ -452,11 +529,11 @@ </ul></div> </dd> </dl></div> -<div class="para"><p>This describes the set of options the calling program wants to affect +<div class="paragraph"><p>This describes the set of options the calling program wants to affect the operation of diffcore library with.</p></div> -<div class="para"><p>Notable members are:</p></div> -<div class="vlist"><dl> -<dt> +<div class="paragraph"><p>Notable members are:</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>output_format</tt> </dt> <dd> @@ -464,7 +541,7 @@ The output format used when <tt>diff_flush()</tt> is run. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>context</tt> </dt> <dd> @@ -472,7 +549,7 @@ Number of context lines to generate in patch output. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>break_opt</tt>, <tt>detect_rename</tt>, <tt>rename-score</tt>, <tt>rename_limit</tt> </dt> <dd> @@ -481,7 +558,7 @@ and copies. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>abbrev</tt> </dt> <dd> @@ -489,7 +566,7 @@ Number of hexdigits to abbreviate raw format output to. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>pickaxe</tt> </dt> <dd> @@ -500,7 +577,7 @@ in its preimage and postimage of the diff_queue. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>flags</tt> </dt> <dd> @@ -509,8 +586,8 @@ operation, but some do not have anything to do with the diffcore library. </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> BINARY, TEXT </dt> <dd> @@ -518,7 +595,7 @@ Affects the way how a file that is seemingly binary is treated. </p> </dd> -<dt> +<dt class="hdlist1"> FULL_INDEX </dt> <dd> @@ -527,7 +604,7 @@ names on the "index" lines. </p> </dd> -<dt> +<dt class="hdlist1"> FIND_COPIES_HARDER </dt> <dd> @@ -536,7 +613,7 @@ filepairs to allow copies from unmodified files be detected. </p> </dd> -<dt> +<dt class="hdlist1"> COLOR_DIFF </dt> <dd> @@ -544,7 +621,7 @@ Output should be colored. </p> </dd> -<dt> +<dt class="hdlist1"> COLOR_DIFF_WORDS </dt> <dd> @@ -552,7 +629,7 @@ Output is a colored word-diff. </p> </dd> -<dt> +<dt class="hdlist1"> NO_INDEX </dt> <dd> @@ -561,7 +638,7 @@ in random locations on the filesystem. </p> </dd> -<dt> +<dt class="hdlist1"> ALLOW_EXTERNAL </dt> <dd> @@ -570,7 +647,7 @@ output routine. Plumbing disables this to ensure stable output. </p> </dd> -<dt> +<dt class="hdlist1"> QUIET </dt> <dd> @@ -578,7 +655,7 @@ Do not show any output. </p> </dd> -<dt> +<dt class="hdlist1"> REVERSE_DIFF </dt> <dd> @@ -587,7 +664,7 @@ filepairs reversed; <tt>one</tt> is two, and <tt>two</tt> is one. </p> </dd> -<dt> +<dt class="hdlist1"> EXIT_WITH_STATUS </dt> <dd> @@ -597,7 +674,7 @@ difference using program exit code. </p> </dd> -<dt> +<dt class="hdlist1"> HAS_CHANGES </dt> <dd> @@ -605,7 +682,7 @@ Internal; used for optimization to see if there is any change. </p> </dd> -<dt> +<dt class="hdlist1"> SILENT_ON_REMOVE </dt> <dd> @@ -613,7 +690,7 @@ Affects if diff-files shows removed files. </p> </dd> -<dt> +<dt class="hdlist1"> RECURSIVE, TREE_IN_RECURSIVE </dt> <dd> @@ -626,11 +703,11 @@ </dl></div> </dd> </dl></div> -<div class="para"><p>(JC)</p></div> +<div class="paragraph"><p>(JC)</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:10 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-directory-listing.html b/technical/api-directory-listing.html index 46c19c5..cf6c25f 100644 --- a/technical/api-directory-listing.html +++ b/technical/api-directory-listing.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>directory listing API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>directory listing API</title> </head> <body> <div id="header"> @@ -311,18 +388,18 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The directory listing API is used to enumerate paths in the work tree, +<div class="paragraph"><p>The directory listing API is used to enumerate paths in the work tree, optionally taking <tt>.git/info/exclude</tt> and <tt>.gitignore</tt> files per directory into account.</p></div> </div> </div> <h2 id="_data_structure">Data structure</h2> <div class="sectionbody"> -<div class="para"><p><tt>struct dir_struct</tt> structure is used to pass directory traversal +<div class="paragraph"><p><tt>struct dir_struct</tt> structure is used to pass directory traversal options to the library and to record the paths discovered. The notable options are:</p></div> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>exclude_per_dir</tt> </dt> <dd> @@ -331,7 +408,7 @@ files (typically <tt>.gitignore</tt>). </p> </dd> -<dt> +<dt class="hdlist1"> <tt>collect_ignored</tt> </dt> <dd> @@ -339,7 +416,7 @@ Include paths that are to be excluded in the result. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>show_ignored</tt> </dt> <dd> @@ -348,7 +425,7 @@ files. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>show_other_directories</tt> </dt> <dd> @@ -356,7 +433,7 @@ Include a directory that is not tracked. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>hide_empty_directories</tt> </dt> <dd> @@ -364,7 +441,7 @@ Do not include a directory that is not tracked and is empty. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>no_gitlinks</tt> </dt> <dd> @@ -373,10 +450,10 @@ directory. Otherwise it is shown as a directory. </p> </dd> -<dt> +<dt class="hdlist1"> The result of the enumeration is left in these fields </dt> -<dt> +<dt class="hdlist1"> <tt>entries[]</tt> </dt> <dd> @@ -385,7 +462,7 @@ a path. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>nr</tt> </dt> <dd> @@ -393,7 +470,7 @@ The number of members in <tt>entries[]</tt> array. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>alloc</tt> </dt> <dd> @@ -405,9 +482,9 @@ </div> <h2 id="_calling_sequence">Calling sequence</h2> <div class="sectionbody"> -<div class="para"><p>Note: index may be looked at for .gitignore files that are CE_SKIP_WORKTREE +<div class="paragraph"><p>Note: index may be looked at for .gitignore files that are CE_SKIP_WORKTREE marked. If you to exclude files, make sure you have loaded index first.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> Prepare <tt>struct dir_struct dir</tt> and clear it with <tt>memset(&dir, 0, @@ -439,11 +516,11 @@ </p> </li> </ul></div> -<div class="para"><p>(JC)</p></div> +<div class="paragraph"><p>(JC)</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:10 UTC +Last updated 2010-01-13 23:08:36 UTC </div> </div> </body> diff --git a/technical/api-gitattributes.html b/technical/api-gitattributes.html index 561ac56..94ba75d 100644 --- a/technical/api-gitattributes.html +++ b/technical/api-gitattributes.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>gitattributes API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>gitattributes API</title> </head> <body> <div id="header"> @@ -311,14 +388,14 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>gitattributes mechanism gives a uniform way to associate various +<div class="paragraph"><p>gitattributes mechanism gives a uniform way to associate various attributes to set of paths.</p></div> </div> </div> <h2 id="_data_structure">Data Structure</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>struct git_attr</tt> </dt> <dd> @@ -329,7 +406,7 @@ structure is of no interest to the calling programs. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>struct git_attr_check</tt> </dt> <dd> @@ -342,7 +419,7 @@ </div> <h2 id="_calling_sequence">Calling Sequence</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> Prepare an array of <tt>struct git_attr_check</tt> to define the list of @@ -365,11 +442,11 @@ </div> <h2 id="_attribute_values">Attribute Values</h2> <div class="sectionbody"> -<div class="para"><p>An attribute for a path can be in one of four states: Set, Unset, +<div class="paragraph"><p>An attribute for a path can be in one of four states: Set, Unset, Unspecified or set to a string, and <tt>.value</tt> member of <tt>struct git_attr_check</tt> records it. There are three macros to check these:</p></div> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>ATTR_TRUE()</tt> </dt> <dd> @@ -377,7 +454,7 @@ Returns true if the attribute is Set for the path. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>ATTR_FALSE()</tt> </dt> <dd> @@ -385,7 +462,7 @@ Returns true if the attribute is Unset for the path. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>ATTR_UNSET()</tt> </dt> <dd> @@ -394,13 +471,13 @@ </p> </dd> </dl></div> -<div class="para"><p>If none of the above returns true, <tt>.value</tt> member points at a string +<div class="paragraph"><p>If none of the above returns true, <tt>.value</tt> member points at a string value of the attribute for the path.</p></div> </div> <h2 id="_example">Example</h2> <div class="sectionbody"> -<div class="para"><p>To see how attributes "crlf" and "indent" are set for different paths.</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>To see how attributes "crlf" and "indent" are set for different paths.</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> Prepare an array of <tt>struct git_attr_check</tt> with two elements (because @@ -420,7 +497,7 @@ check[1].attr = git_attr("ident", 5); }</tt></pre> </div></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> Call <tt>git_checkattr()</tt> with the prepared array of <tt>struct git_attr_check</tt>: @@ -434,7 +511,7 @@ setup_check(); git_checkattr(path, ARRAY_SIZE(check), check);</tt></pre> </div></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> Act on <tt>.value</tt> member of the result, left in <tt>check[]</tt>: @@ -461,11 +538,11 @@ ... }</tt></pre> </div></div> -<div class="para"><p>(JC)</p></div> +<div class="paragraph"><p>(JC)</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:10 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-grep.html b/technical/api-grep.html index d3135b5..201bd2e 100644 --- a/technical/api-grep.html +++ b/technical/api-grep.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>grep API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>grep API</title> </head> <body> <div id="header"> @@ -311,20 +388,20 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <grep.h>, things like:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about <grep.h>, things like:</p></div> +<div class="ulist"><ul> <li> <p> grep_buffer() </p> </li> </ul></div> -<div class="para"><p>(JC)</p></div> +<div class="paragraph"><p>(JC)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:11 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-hash.html b/technical/api-hash.html index aed89e7..6a220f3 100644 --- a/technical/api-hash.html +++ b/technical/api-hash.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>hash API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>hash API</title> </head> <body> <div id="header"> @@ -311,14 +388,14 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The hash API is a collection of simple hash table functions. Users are expected +<div class="paragraph"><p>The hash API is a collection of simple hash table functions. Users are expected to implement their own hashing.</p></div> </div> </div> <h2 id="_data_structures">Data Structures</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>struct hash_table</tt> </dt> <dd> @@ -329,13 +406,13 @@ valid entries. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>struct hash_table_entry</tt> </dt> <dd> <p> An opaque structure representing an entry in the hash table. The <tt>hash</tt> - member is the entry's hash key and the <tt>ptr</tt> member is the entry's + member is the entry’s hash key and the <tt>ptr</tt> member is the entry’s value. </p> </dd> @@ -343,8 +420,8 @@ </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>init_hash</tt> </dt> <dd> @@ -352,7 +429,7 @@ Initialize the hash table. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>free_hash</tt> </dt> <dd> @@ -360,33 +437,33 @@ Release memory associated with the hash table. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>insert_hash</tt> </dt> <dd> <p> Insert a pointer into the hash table. If an entry with that hash - already exists, a pointer to the existing entry's value is returned. + already exists, a pointer to the existing entry’s value is returned. Otherwise NULL is returned. This allows callers to implement chaining, etc. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>lookup_hash</tt> </dt> <dd> <p> Lookup an entry in the hash table. If an entry with that hash exists - the entry's value is returned. Otherwise NULL is returned. + the entry’s value is returned. Otherwise NULL is returned. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>for_each_hash</tt> </dt> <dd> <p> Call a function for each entry in the hash table. The function is - expected to take the entry's value as its only argument and return an + expected to take the entry’s value as its only argument and return an int. If the function returns a negative int the loop is aborted immediately. Otherwise, the return value is accumulated and the sum returned upon completion of the loop. @@ -396,7 +473,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:11 UTC +Last updated 2009-12-20 23:01:16 UTC </div> </div> </body> diff --git a/technical/api-history-graph.html b/technical/api-history-graph.html index 435684a..c3e7aad 100644 --- a/technical/api-history-graph.html +++ b/technical/api-history-graph.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>history graph API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>history graph API</title> </head> <body> <div id="header"> @@ -311,14 +388,14 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The graph API is used to draw a text-based representation of the commit +<div class="paragraph"><p>The graph API is used to draw a text-based representation of the commit history. The API generates the graph in a line-by-line fashion.</p></div> </div> </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="para"><p>Core functions:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Core functions:</p></div> +<div class="ulist"><ul> <li> <p> <tt>graph_init()</tt> creates a new <tt>struct git_graph</tt> @@ -354,11 +431,11 @@ </p> </li> </ul></div> -<div class="para"><p>The following utility functions are wrappers around <tt>graph_next_line()</tt> and +<div class="paragraph"><p>The following utility functions are wrappers around <tt>graph_next_line()</tt> and <tt>graph_is_commit_finished()</tt>. They always print the output to stdout. They can all be called with a NULL graph argument, in which case no graph output will be printed.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>graph_show_commit()</tt> calls <tt>graph_next_line()</tt> until it returns non-zero. @@ -411,17 +488,17 @@ </div> <h2 id="_data_structure">Data structure</h2> <div class="sectionbody"> -<div class="para"><p><tt>struct git_graph</tt> is an opaque data type used to store the current graph +<div class="paragraph"><p><tt>struct git_graph</tt> is an opaque data type used to store the current graph state.</p></div> </div> <h2 id="_calling_sequence">Calling sequence</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> Create a <tt>struct git_graph</tt> by calling <tt>graph_init()</tt>. When using the revision walking API, this is done automatically by <tt>setup_revisions()</tt> if - the <em>—graph</em> option is supplied. + the <em>--graph</em> option is supplied. </p> </li> <li> @@ -447,7 +524,7 @@ </div> <h2 id="_limitations">Limitations</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>graph_update()</tt> must be called with commits in topological order. It should @@ -462,7 +539,7 @@ on all parents of that commit. Parents must not be skipped, or the graph output will appear incorrect. </p> -<div class="para"><p><tt>graph_update()</tt> may be used on a pruned set of commits only if the parent list +<div class="paragraph"><p><tt>graph_update()</tt> may be used on a pruned set of commits only if the parent list has been rewritten so as to include only ancestors from the pruned set.</p></div> </li> <li> @@ -502,7 +579,7 @@ </div> <h2 id="_sample_output">Sample output</h2> <div class="sectionbody"> -<div class="para"><p>The following is an example of the output from the graph API. This output does +<div class="paragraph"><p>The following is an example of the output from the graph API. This output does not include any commit summary information—callers are responsible for outputting that information, if desired.</p></div> <div class="listingblock"> @@ -541,7 +618,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:11 UTC +Last updated 2009-11-23 06:10:40 UTC </div> </div> </body> diff --git a/technical/api-in-core-index.html b/technical/api-in-core-index.html index ec2c8b0..07fd211 100644 --- a/technical/api-in-core-index.html +++ b/technical/api-in-core-index.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>in-core index API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>in-core index API</title> </head> <body> <div id="header"> @@ -311,11 +388,11 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <read-cache.c> and <cache-tree.c>, things like:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about <read-cache.c> and <cache-tree.c>, things like:</p></div> +<div class="ulist"><ul> <li> <p> -cache -> the_index macros +cache → the_index macros </p> </li> <li> @@ -380,12 +457,12 @@ </p> </li> </ul></div> -<div class="para"><p>(JC, Linus)</p></div> +<div class="paragraph"><p>(JC, Linus)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:12 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-index.html b/technical/api-index.html index 93d6862..dd34a4b 100644 --- a/technical/api-index.html +++ b/technical/api-index.html
@@ -517,7 +517,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-11-18 00:52:24 UTC +Last updated 2011-01-31 05:00:42 UTC </div> </div> </body>
diff --git a/technical/api-lockfile.html b/technical/api-lockfile.html index bef29d7..62b7981 100644 --- a/technical/api-lockfile.html +++ b/technical/api-lockfile.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>lockfile API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>lockfile API</title> </head> <body> <div id="header"> @@ -311,8 +388,8 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The lockfile API serves two purposes:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>The lockfile API serves two purposes:</p></div> +<div class="ulist"><ul> <li> <p> Mutual exclusion. When we write out a new index file, first @@ -339,8 +416,8 @@ </div> <h2 id="_the_functions">The functions</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> hold_lock_file_for_update </dt> <dd> @@ -354,7 +431,7 @@ returns a negative integer to the caller on failure. </p> </dd> -<dt> +<dt class="hdlist1"> commit_lock_file </dt> <dd> @@ -366,7 +443,7 @@ value on failure to close(2) or rename(2). </p> </dd> -<dt> +<dt class="hdlist1"> rollback_lock_file </dt> <dd> @@ -376,7 +453,7 @@ close the file descriptor and remove the lockfile. </p> </dd> -<dt> +<dt class="hdlist1"> close_lock_file </dt> <dd> @@ -388,14 +465,14 @@ </p> </dd> </dl></div> -<div class="para"><p>Because the structure is used in an <tt>atexit(3)</tt> handler, its +<div class="paragraph"><p>Because the structure is used in an <tt>atexit(3)</tt> handler, its storage has to stay throughout the life of the program. It cannot be an auto variable allocated on the stack.</p></div> -<div class="para"><p>Call <tt>commit_lock_file()</tt> or <tt>rollback_lock_file()</tt> when you are +<div class="paragraph"><p>Call <tt>commit_lock_file()</tt> or <tt>rollback_lock_file()</tt> when you are done writing to the file descriptor. If you do not call either and simply <tt>exit(3)</tt> from the program, an <tt>atexit(3)</tt> handler will close and remove the lockfile.</p></div> -<div class="para"><p>If you need to close the file descriptor you obtained from +<div class="paragraph"><p>If you need to close the file descriptor you obtained from <tt>hold_lock_file_for_update</tt> function yourself, do so by calling <tt>close_lock_file()</tt>. You should never call <tt>close(2)</tt> yourself! Otherwise the <tt>struct @@ -409,7 +486,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:12 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-object-access.html b/technical/api-object-access.html index 709e7a4..a2e483b 100644 --- a/technical/api-object-access.html +++ b/technical/api-object-access.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>object access API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>object access API</title> </head> <body> <div id="header"> @@ -311,8 +388,8 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <sha1_file.c> and <object.h> family, things like</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about <sha1_file.c> and <object.h> family, things like</p></div> +<div class="ulist"><ul> <li> <p> read_sha1_file() @@ -354,12 +431,12 @@ </p> </li> </ul></div> -<div class="para"><p>(JC, Shawn, Daniel, Dscho, Linus)</p></div> +<div class="paragraph"><p>(JC, Shawn, Daniel, Dscho, Linus)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:12 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-quote.html b/technical/api-quote.html index e34d07a..dc715b0 100644 --- a/technical/api-quote.html +++ b/technical/api-quote.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>quote API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>quote API</title> </head> <body> <div id="header"> @@ -311,8 +388,8 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <quote.h>, things like</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about <quote.h>, things like</p></div> +<div class="ulist"><ul> <li> <p> sq_quote and unquote @@ -329,12 +406,12 @@ </p> </li> </ul></div> -<div class="para"><p>(JC)</p></div> +<div class="paragraph"><p>(JC)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:13 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-remote.html b/technical/api-remote.html index e6b2027..f709fa6 100644 --- a/technical/api-remote.html +++ b/technical/api-remote.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>Remotes configuration API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>Remotes configuration API</title> </head> <body> <div id="header"> @@ -311,7 +388,7 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The API in remote.h gives access to the configuration related to +<div class="paragraph"><p>The API in remote.h gives access to the configuration related to remotes. It handles all three configuration mechanisms historically and currently used by git, and presents the information in a uniform fashion. Note that the code also handles plain URLs without any @@ -320,16 +397,16 @@ </div> <h2 id="_struct_remote">struct remote</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>name</tt> </dt> <dd> <p> - The user's nickname for the remote + The user’s nickname for the remote </p> </dd> -<dt> +<dt class="hdlist1"> <tt>url</tt> </dt> <dd> @@ -337,7 +414,7 @@ An array of all of the url_nr URLs configured for the remote </p> </dd> -<dt> +<dt class="hdlist1"> <tt>pushurl</tt> </dt> <dd> @@ -345,7 +422,7 @@ An array of all of the pushurl_nr push URLs configured for the remote </p> </dd> -<dt> +<dt class="hdlist1"> <tt>push</tt> </dt> <dd> @@ -355,7 +432,7 @@ being the quantity. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>fetch</tt> </dt> <dd> @@ -365,7 +442,7 @@ being the quantity. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>fetch_tags</tt> </dt> <dd> @@ -377,7 +454,7 @@ tags. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>receivepack</tt>, <tt>uploadpack</tt> </dt> <dd> @@ -386,7 +463,7 @@ git-native protocols. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>http_proxy</tt> </dt> <dd> @@ -395,34 +472,34 @@ </p> </dd> </dl></div> -<div class="para"><p>struct remotes can be found by name with remote_get(), and iterated +<div class="paragraph"><p>struct remotes can be found by name with remote_get(), and iterated through with for_each_remote(). remote_get(NULL) will return the default remote, given the current branch and configuration.</p></div> </div> <h2 id="_struct_refspec">struct refspec</h2> <div class="sectionbody"> -<div class="para"><p>A struct refspec holds the parsed interpretation of a refspec. If it +<div class="paragraph"><p>A struct refspec holds the parsed interpretation of a refspec. If it will force updates (starts with a <em>+</em>), force is true. If it is a pattern (sides end with <em>*</em>) pattern is true. src and dest are the two sides (if a pattern, only the part outside of the wildcards); if there is only one side, it is src, and dst is NULL; if sides exist but are empty (i.e., the refspec either starts or ends with <em>:</em>), the corresponding side is "".</p></div> -<div class="para"><p>This parsing can be done to an array of strings to give an array of +<div class="paragraph"><p>This parsing can be done to an array of strings to give an array of struct refpsecs with parse_ref_spec().</p></div> -<div class="para"><p>remote_find_tracking(), given a remote and a struct refspec with +<div class="paragraph"><p>remote_find_tracking(), given a remote and a struct refspec with either src or dst filled out, will fill out the other such that the result is in the "fetch" specification for the remote (note that this evaluates patterns and returns a single result).</p></div> </div> <h2 id="_struct_branch">struct branch</h2> <div class="sectionbody"> -<div class="para"><p>Note that this may end up moving to branch.h</p></div> -<div class="para"><p>struct branch holds the configuration for a branch. It can be looked +<div class="paragraph"><p>Note that this may end up moving to branch.h</p></div> +<div class="paragraph"><p>struct branch holds the configuration for a branch. It can be looked branch_get(NULL) for HEAD.</p></div> -<div class="para"><p>It contains:</p></div> -<div class="vlist"><dl> -<dt> +<div class="paragraph"><p>It contains:</p></div> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>name</tt> </dt> <dd> @@ -430,7 +507,7 @@ The short name of the branch. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>refname</tt> </dt> <dd> @@ -438,7 +515,7 @@ The full path for the branch ref. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>remote_name</tt> </dt> <dd> @@ -446,7 +523,7 @@ The name of the remote listed in the configuration. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>remote</tt> </dt> <dd> @@ -454,7 +531,7 @@ The struct remote for that remote. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>merge_name</tt> </dt> <dd> @@ -462,17 +539,17 @@ An array of the "merge" lines in the configuration. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>merge</tt> </dt> <dd> <p> An array of the struct refspecs used for the merge lines. That - is, merge[i]->dst is a local tracking ref which should be + is, merge[i]→dst is a local tracking ref which should be merged into this branch by default. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>merge_nr</tt> </dt> <dd> @@ -481,18 +558,18 @@ </p> </dd> </dl></div> -<div class="para"><p>branch_has_merge_config() returns true if the given branch has merge +<div class="paragraph"><p>branch_has_merge_config() returns true if the given branch has merge configuration given.</p></div> </div> <h2 id="_other_stuff">Other stuff</h2> <div class="sectionbody"> -<div class="para"><p>There is other stuff in remote.h that is related, in general, to the +<div class="paragraph"><p>There is other stuff in remote.h that is related, in general, to the process of interacting with remotes.</p></div> -<div class="para"><p>(Daniel Barkalow)</p></div> +<div class="paragraph"><p>(Daniel Barkalow)</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:13 UTC +Last updated 2009-06-21 08:02:57 UTC </div> </div> </body> diff --git a/technical/api-revision-walking.html b/technical/api-revision-walking.html index 666b590..7f0aed2 100644 --- a/technical/api-revision-walking.html +++ b/technical/api-revision-walking.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>revision walking API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>revision walking API</title> </head> <body> <div id="header"> @@ -311,21 +388,21 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The revision walking API offers functions to build a list of revisions +<div class="paragraph"><p>The revision walking API offers functions to build a list of revisions and then iterate over that list.</p></div> </div> </div> <h2 id="_calling_sequence">Calling sequence</h2> <div class="sectionbody"> -<div class="para"><p>The walking API has a given calling sequence: first you need to +<div class="paragraph"><p>The walking API has a given calling sequence: first you need to initialize a rev_info structure, then add revisions to control what kind of revision list do you want to get, finally you can iterate over the revision list.</p></div> </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>init_revisions</tt> </dt> <dd> @@ -335,11 +412,11 @@ variable will be set to it. This is typically the first function you want to call when you want to deal with a revision list. After calling this function, you are free to customize options, like set - <tt>.ignore_merges</tt> to 0 if you don't want to ignore merges, and so on. See + <tt>.ignore_merges</tt> to 0 if you don’t want to ignore merges, and so on. See <tt>revision.h</tt> for a complete list of available options. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>add_pending_object</tt> </dt> <dd> @@ -360,19 +437,19 @@ </tr></table> </div> </dd> -<dt> +<dt class="hdlist1"> <tt>setup_revisions</tt> </dt> <dd> <p> Parse revision information, filling in the <tt>rev_info</tt> structure, and removing the used arguments from the argument list. Returns the number - of arguments left that weren't recognized, which are also moved to the + of arguments left that weren’t recognized, which are also moved to the head of the argument list. The last parameter is used in case no parameter given by the first two arguments. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>prepare_revision_walk</tt> </dt> <dd> @@ -382,7 +459,7 @@ start using get_revision() to do the iteration. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>get_revision</tt> </dt> <dd> @@ -396,8 +473,8 @@ </div> <h2 id="_data_structures">Data structures</h2> <div class="sectionbody"> -<div class="para"><p>Talk about <revision.h>, things like:</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about <revision.h>, things like:</p></div> +<div class="ulist"><ul> <li> <p> two diff_options, one for path limiting, another for output; @@ -409,11 +486,11 @@ </p> </li> </ul></div> -<div class="para"><p>(Linus, JC, Dscho)</p></div> +<div class="paragraph"><p>(Linus, JC, Dscho)</p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:14 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-run-command.html b/technical/api-run-command.html index 5f87517..a378a84 100644 --- a/technical/api-run-command.html +++ b/technical/api-run-command.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>run-command API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>run-command API</title> </head> <body> <div id="header"> @@ -311,18 +388,18 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The run-command API offers a versatile tool to run sub-processes with +<div class="paragraph"><p>The run-command API offers a versatile tool to run sub-processes with redirected input and output as well as with a modified environment and an alternate current directory.</p></div> -<div class="para"><p>A similar API offers the capability to run a function asynchronously, +<div class="paragraph"><p>A similar API offers the capability to run a function asynchronously, which is primarily used to capture the output that the function produces in the caller in order to process it.</p></div> </div> </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>start_command</tt> </dt> <dd> @@ -332,7 +409,7 @@ See below for details. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>finish_command</tt> </dt> <dd> @@ -341,7 +418,7 @@ start_command(). </p> </dd> -<dt> +<dt class="hdlist1"> <tt>run_command</tt> </dt> <dd> @@ -351,7 +428,7 @@ to a <tt>struct child_process</tt> that specifies the details. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>run_command_v_opt</tt>, <tt>run_command_v_opt_cd_env</tt> </dt> <dd> @@ -368,8 +445,8 @@ </p> </dd> </dl></div> -<div class="para"><p>The functions above do the following:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>The functions above do the following:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> If a system call failed, errno is set and -1 is returned. A diagnostic @@ -395,10 +472,10 @@ signal number - 128, ie. it is negative and so indicates an unusual condition; a diagnostic is printed. This return value can be passed to exit(2), which will report the same code to the parent process that a - POSIX shell's $? would report for a program that died from the signal. + POSIX shell’s $? would report for a program that died from the signal. </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>start_async</tt> </dt> <dd> @@ -408,7 +485,7 @@ for communication with the function. See below for details. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>finish_async</tt> </dt> <dd> @@ -417,7 +494,7 @@ started with start_async(). </p> </dd> -<dt> +<dt class="hdlist1"> <tt>run_hook</tt> </dt> <dd> @@ -442,17 +519,17 @@ </div> <h2 id="_data_structures">Data structures</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct child_process</tt> </p> </li> </ul></div> -<div class="para"><p>This describes the arguments, redirections, and environment of a +<div class="paragraph"><p>This describes the arguments, redirections, and environment of a command to run in a sub-process.</p></div> -<div class="para"><p>The caller:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>The caller:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> allocates and clears (memset(&chld, 0, sizeof(chld));) a @@ -485,13 +562,13 @@ </p> </li> </ol></div> -<div class="para"><p>The .argv member is set up as an array of string pointers (NULL +<div class="paragraph"><p>The .argv member is set up as an array of string pointers (NULL terminated), of which .argv[0] is the program name to run (usually without a path). If the command to run is a git command, set argv[0] to the command name without the <em>git-</em> prefix and set .git_cmd = 1.</p></div> -<div class="para"><p>The members .in, .out, .err are used to redirect stdin, stdout, +<div class="paragraph"><p>The members .in, .out, .err are used to redirect stdin, stdout, stderr as follows:</p></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> Specify 0 to request no special redirection. No new file descriptor @@ -556,39 +633,39 @@ </div></div> </li> </ol></div> -<div class="para"><p>To modify the environment of the sub-process, specify an array of +<div class="paragraph"><p>To modify the environment of the sub-process, specify an array of string pointers (NULL terminated) in .env:</p></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> If the string is of the form "VAR=value", i.e. it contains <em>=</em> - the variable is added to the child process's environment. + the variable is added to the child process’s environment. </p> </li> <li> <p> If the string does not contain <em>=</em>, it names an environment - variable that will be removed from the child process's environment. + variable that will be removed from the child process’s environment. </p> </li> </ol></div> -<div class="para"><p>To specify a new initial working directory for the sub-process, +<div class="paragraph"><p>To specify a new initial working directory for the sub-process, specify it in the .dir member.</p></div> -<div class="para"><p>If the program cannot be found, the functions return -1 and set +<div class="paragraph"><p>If the program cannot be found, the functions return -1 and set errno to ENOENT. Normally, an error message is printed, but if .silent_exec_failure is set to 1, no message is printed for this special error condition.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct async</tt> </p> </li> </ul></div> -<div class="para"><p>This describes a function to run asynchronously, whose purpose is +<div class="paragraph"><p>This describes a function to run asynchronously, whose purpose is to produce output that the caller reads.</p></div> -<div class="para"><p>The caller:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>The caller:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> allocates and clears (memset(&asy, 0, sizeof(asy));) a @@ -621,9 +698,9 @@ </p> </li> </ol></div> -<div class="para"><p>The members .in, .out are used to provide a set of fd's for +<div class="paragraph"><p>The members .in, .out are used to provide a set of fd’s for communication between the caller and the callee as follows:</p></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> Specify 0 to have no file descriptor passed. The callee will @@ -669,12 +746,12 @@ </div></div> </li> </ol></div> -<div class="para"><p>The function pointer in .proc has the following signature:</p></div> +<div class="paragraph"><p>The function pointer in .proc has the following signature:</p></div> <div class="literalblock"> <div class="content"> <pre><tt>int proc(int in, int out, void *data);</tt></pre> </div></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> in, out specifies a set of file descriptors to which the function @@ -698,21 +775,21 @@ </p> </li> </ol></div> -<div class="para"><p>There are serious restrictions on what the asynchronous function can do +<div class="paragraph"><p>There are serious restrictions on what the asynchronous function can do because this facility is implemented by a thread in the same address space on most platforms (when pthreads is available), but by a pipe to a forked process otherwise:</p></div> -<div class="olist"><ol> +<div class="olist arabic"><ol class="arabic"> <li> <p> -It cannot change the program's state (global variables, environment, +It cannot change the program’s state (global variables, environment, etc.) in a way that the caller notices; in other words, .in and .out are the only communication channels to the caller. </p> </li> <li> <p> -It must not change the program's state that the caller of the +It must not change the program’s state that the caller of the facility also uses. </p> </li> @@ -720,7 +797,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:15 UTC +Last updated 2010-06-21 15:23:38 UTC </div> </div> </body> diff --git a/technical/api-setup.html b/technical/api-setup.html index 9a92613..1cbc827 100644 --- a/technical/api-setup.html +++ b/technical/api-setup.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>setup API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>setup API</title> </head> <body> <div id="header"> @@ -311,8 +388,8 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about</p></div> -<div class="ilist"><ul> +<div class="paragraph"><p>Talk about</p></div> +<div class="ulist"><ul> <li> <p> setup_git_directory() @@ -344,12 +421,12 @@ </p> </li> </ul></div> -<div class="para"><p>(Dscho)</p></div> +<div class="paragraph"><p>(Dscho)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:15 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> diff --git a/technical/api-strbuf.html b/technical/api-strbuf.html index d8890d3..cd63f6a 100644 --- a/technical/api-strbuf.html +++ b/technical/api-strbuf.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>strbuf API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>strbuf API</title> </head> <body> <div id="header"> @@ -311,26 +388,26 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>strbuf's are meant to be used with all the usual C string and memory -APIs. Given that the length of the buffer is known, it's often better to +<div class="paragraph"><p>strbuf’s are meant to be used with all the usual C string and memory +APIs. Given that the length of the buffer is known, it’s often better to use the mem* functions than a str* one (memchr vs. strchr e.g.). Though, one has to be careful about the fact that str* functions often stop on NULs and that strbufs may have embedded NULs.</p></div> -<div class="para"><p>An strbuf is NUL terminated for convenience, but no function in the +<div class="paragraph"><p>An strbuf is NUL terminated for convenience, but no function in the strbuf API actually relies on the string being free of NULs.</p></div> -<div class="para"><p>strbufs has some invariants that are very important to keep in mind:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>strbufs has some invariants that are very important to keep in mind:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> The <tt>buf</tt> member is never NULL, so it can be used in any usual C -string operations safely. strbuf's _have_ to be initialized either by +string operations safely. strbuf’s <em>have</em> to be initialized either by <tt>strbuf_init()</tt> or by <tt>= STRBUF_INIT</tt> before the invariants, though. </p> -<div class="para"><p>Do <strong>not</strong> assume anything on what <tt>buf</tt> really is (e.g. if it is +<div class="paragraph"><p>Do <strong>not</strong> assume anything on what <tt>buf</tt> really is (e.g. if it is allocated memory or not), use <tt>strbuf_detach()</tt> to unwrap a memory buffer from its strbuf shell in a safe way. That is the sole supported way. This will give you a malloced buffer that you can later <tt>free()</tt>.</p></div> -<div class="para"><p>However, it is totally safe to modify anything in the string pointed by +<div class="paragraph"><p>However, it is totally safe to modify anything in the string pointed by the <tt>buf</tt> member, between the indices <tt>0</tt> and <tt>len-1</tt> (inclusive).</p></div> </li> <li> @@ -351,13 +428,13 @@ </div> <div class="listingblock"> <div class="content"> -<pre><tt>strbuf_grow(sb, SOME_SIZE); <b>(1)</b> +<pre><tt>strbuf_grow(sb, SOME_SIZE); <b><1></b> strbuf_setlen(sb, sb->len + SOME_OTHER_SIZE);</tt></pre> </div></div> -<div class="colist"><ol> +<div class="colist arabic"><ol> <li> <p> -Here, the memory array starting at <tt>sb->buf</tt>, and of length +Here, the memory array starting at <tt>sb→buf</tt>, and of length <tt>strbuf_avail(sb)</tt> is all yours, and you can be sure that <tt>strbuf_avail(sb)</tt> is at least <tt>SOME_SIZE</tt>. </p> @@ -369,15 +446,15 @@ <td class="content"><tt>SOME_OTHER_SIZE</tt> must be smaller or equal to <tt>strbuf_avail(sb)</tt>.</td> </tr></table> </div> -<div class="para"><p>Doing so is safe, though if it has to be done in many places, adding the +<div class="paragraph"><p>Doing so is safe, though if it has to be done in many places, adding the missing API to the strbuf module is the way to go.</p></div> <div class="admonitionblock"> <table><tr> <td class="icon"> <div class="title">Warning</div> </td> -<td class="content">Do _not_ assume that the area that is yours is of size <tt>alloc -- 1</tt> even if it's true in the current implementation. Alloc is somehow a +<td class="content">Do <em>not</em> assume that the area that is yours is of size <tt>alloc +- 1</tt> even if it’s true in the current implementation. Alloc is somehow a "private" member that should not be messed with. Use <tt>strbuf_avail()</tt> instead.</td> </tr></table> @@ -390,26 +467,26 @@ </div> <h2 id="_data_structures">Data structures</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct strbuf</tt> </p> </li> </ul></div> -<div class="para"><p>This is the string buffer structure. The <tt>len</tt> member can be used to +<div class="paragraph"><p>This is the string buffer structure. The <tt>len</tt> member can be used to determine the current length of the string, and <tt>buf</tt> member provides access to the string itself.</p></div> </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> Life cycle </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>strbuf_init</tt> </dt> <dd> @@ -418,7 +495,7 @@ number to allocate memory, in case you want to prevent further reallocs. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_release</tt> </dt> <dd> @@ -427,7 +504,7 @@ string buffer after using this function, unless you initialize it again. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_detach</tt> </dt> <dd> @@ -437,7 +514,7 @@ to release it with <tt>free(3)</tt> when you are done with it. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_attach</tt> </dt> <dd> @@ -445,12 +522,12 @@ Attach a string to a buffer. You should specify the string to attach, the current length of the string and the amount of allocated memory. The amount must be larger than the string length, because the string you - pass is supposed to be a NUL-terminated string. This string _must_ be + pass is supposed to be a NUL-terminated string. This string <em>must</em> be malloc()ed, and after attaching, the pointer cannot be relied upon anymore, and neither be free()d directly. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_swap</tt> </dt> <dd> @@ -464,8 +541,8 @@ <p> Related to the size of the buffer </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>strbuf_avail</tt> </dt> <dd> @@ -473,7 +550,7 @@ Determine the amount of allocated but unused memory. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_grow</tt> </dt> <dd> @@ -485,7 +562,7 @@ some cases. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_setlen</tt> </dt> <dd> @@ -497,7 +574,7 @@ with</em>. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_reset</tt> </dt> <dd> @@ -511,8 +588,8 @@ <p> Related to the contents of the buffer </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>strbuf_rtrim</tt> </dt> <dd> @@ -520,7 +597,7 @@ Strip whitespace from the end of a string. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_cmp</tt> </dt> <dd> @@ -544,13 +621,13 @@ <div class="title">Note</div> </td> <td class="content">All of the functions in this section will grow the buffer as necessary. -If they fail for some reason other than memory shortage and the buffer hadn't +If they fail for some reason other than memory shortage and the buffer hadn’t been allocated before (i.e. the <tt>struct strbuf</tt> was set to <tt>STRBUF_INIT</tt>), then they will free() it.</td> </tr></table> </div> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>strbuf_addch</tt> </dt> <dd> @@ -558,7 +635,7 @@ Add a single character to the buffer. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_insert</tt> </dt> <dd> @@ -567,7 +644,7 @@ will be shifted, not overwritten. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_remove</tt> </dt> <dd> @@ -575,7 +652,7 @@ Remove given amount of data from a given position of the buffer. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_splice</tt> </dt> <dd> @@ -584,7 +661,7 @@ data. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_add</tt> </dt> <dd> @@ -592,7 +669,7 @@ Add data of given length to the buffer. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_addstr</tt> </dt> <dd> @@ -612,13 +689,13 @@ <div class="content"> <pre><tt>strbuf_add(..., s, strlen(s));</tt></pre> </div></div> -<div class="para"><p>Meaning that this is efficient to write things like:</p></div> +<div class="paragraph"><p>Meaning that this is efficient to write things like:</p></div> <div class="listingblock"> <div class="content"> <pre><tt>strbuf_addstr(sb, "immediate string");</tt></pre> </div></div> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_addbuf</tt> </dt> <dd> @@ -626,7 +703,7 @@ Copy the contents of an other buffer at the end of the current one. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_adddup</tt> </dt> <dd> @@ -635,7 +712,7 @@ end of the buffer. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_expand</tt> </dt> <dd> @@ -644,23 +721,23 @@ placeholders. To that end, it parses the string and calls the specified function for every percent sign found. </p> -<div class="para"><p>The callback function is given a pointer to the character after the <tt>%</tt> +<div class="paragraph"><p>The callback function is given a pointer to the character after the <tt>%</tt> and a pointer to the struct strbuf. It is expected to add the expanded version of the placeholder to the strbuf, e.g. to add a newline character if the letter <tt>n</tt> appears after a <tt>%</tt>. The function returns the length of the placeholder recognized and <tt>strbuf_expand()</tt> skips over it.</p></div> -<div class="para"><p>The format <tt>%%</tt> is automatically expanded to a single <tt>%</tt> as a quoting +<div class="paragraph"><p>The format <tt>%%</tt> is automatically expanded to a single <tt>%</tt> as a quoting mechanism; callers do not need to handle the <tt>%</tt> placeholder themselves, and the callback function will not be invoked for this placeholder.</p></div> -<div class="para"><p>All other characters (non-percent and not skipped ones) are copied +<div class="paragraph"><p>All other characters (non-percent and not skipped ones) are copied verbatim to the strbuf. If the callback returned zero, meaning that the placeholder is unknown, then the percent sign is copied, too.</p></div> -<div class="para"><p>In order to facilitate caching and to make it possible to give +<div class="paragraph"><p>In order to facilitate caching and to make it possible to give parameters to the callback, <tt>strbuf_expand()</tt> passes a context pointer, which can be used by the programmer of the callback as she sees fit.</p></div> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_expand_dict_cb</tt> </dt> <dd> @@ -671,7 +748,7 @@ terminated by an entry with placeholder set to NULL. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_addbuf_percentquote</tt> </dt> <dd> @@ -682,7 +759,7 @@ strbuf_expand or to the *printf family of functions. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_addf</tt> </dt> <dd> @@ -690,7 +767,7 @@ Add a formatted string to the buffer. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_fread</tt> </dt> <dd> @@ -709,7 +786,7 @@ </tr></table> </div> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_read</tt> </dt> <dd> @@ -718,7 +795,7 @@ used to give a hint about the file size, to avoid reallocs. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_read_file</tt> </dt> <dd> @@ -727,7 +804,7 @@ can be used to give a hint about the file size, to avoid reallocs. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_readlink</tt> </dt> <dd> @@ -736,7 +813,7 @@ argument can be used to give a hint about the size, to avoid reallocs. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>strbuf_getline</tt> </dt> <dd> @@ -745,7 +822,7 @@ terminator character, typically <tt><em>\n</em></tt>. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>stripspace</tt> </dt> <dd> @@ -754,23 +831,23 @@ comments are considered contents to be removed or not. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>launch_editor</tt> </dt> <dd> <p> Launch the user preferred editor to edit a file and fill the buffer - with the file's contents upon the user completing their editing. The + with the file’s contents upon the user completing their editing. The third argument can be used to set the environment which the editor is run in. If the buffer is NULL the editor is launched as usual but the - file's contents are not read into the buffer upon completion. + file’s contents are not read into the buffer upon completion. </p> </dd> </dl></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:15 UTC +Last updated 2010-01-21 00:41:31 UTC </div> </div> </body> diff --git a/technical/api-string-list.html b/technical/api-string-list.html index c4d008e..63060f0 100644 --- a/technical/api-string-list.html +++ b/technical/api-string-list.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>string-list API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>string-list API</title> </head> <body> <div id="header"> @@ -311,12 +388,12 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The string_list API offers a data structure and functions to handle sorted +<div class="paragraph"><p>The string_list API offers a data structure and functions to handle sorted and unsorted string lists.</p></div> -<div class="para"><p>The <em>string_list</em> struct used to be called <em>path_list</em>, but was renamed +<div class="paragraph"><p>The <em>string_list</em> struct used to be called <em>path_list</em>, but was renamed because it is not specific to paths.</p></div> -<div class="para"><p>The caller:</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>The caller:</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> Allocates and clears a <tt>struct string_list</tt> variable. @@ -329,7 +406,7 @@ when you add something like git_path("…"), since that function returns a static buffer that will change with the next call to git_path(). </p> -<div class="para"><p>If you need something advanced, you can manually malloc() the <tt>items</tt> +<div class="paragraph"><p>If you need something advanced, you can manually malloc() the <tt>items</tt> member (you need this if you add things later) and you should set the <tt>nr</tt> and <tt>alloc</tt> members in that case, too.</p></div> </li> @@ -357,7 +434,7 @@ </p> </li> </ol></div> -<div class="para"><p>Example:</p></div> +<div class="paragraph"><p>Example:</p></div> <div class="listingblock"> <div class="content"> <pre><tt>struct string_list list; @@ -379,7 +456,7 @@ <tt>O(n^2)</tt>).</td> </tr></table> </div> -<div class="para"><p>+ +<div class="paragraph"><p>+ However, if you use the list to check if a certain string was added already, you should not do that (using unsorted_string_list_has_string()), because the complexity would be quadratic again (but with a worse factor).</p></div> @@ -387,13 +464,13 @@ </div> <h2 id="_functions">Functions</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> General ones (works with sorted and unsorted lists as well) </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>print_string_list</tt> </dt> <dd> @@ -403,7 +480,7 @@ string-pointer pairs of the string_list, each one in its own line. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>string_list_clear</tt> </dt> <dd> @@ -420,8 +497,8 @@ <p> Functions for sorted lists only </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>string_list_has_string</tt> </dt> <dd> @@ -429,7 +506,7 @@ Determine if the string_list has a given string or not. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>string_list_insert</tt> </dt> <dd> @@ -438,11 +515,11 @@ handy if you want to write something to the <tt>util</tt> pointer of the string_list_item containing the just added string. </p> -<div class="para"><p>Since this function uses xrealloc() (which die()s if it fails) if the +<div class="paragraph"><p>Since this function uses xrealloc() (which die()s if it fails) if the list needs to grow, it is safe not to check the pointer. I.e. you may -write <tt>string_list_insert(…)->util = …;</tt>.</p></div> +write <tt>string_list_insert(…)→util = …;</tt>.</p></div> </dd> -<dt> +<dt class="hdlist1"> <tt>string_list_lookup</tt> </dt> <dd> @@ -457,8 +534,8 @@ <p> Functions for unsorted lists only </p> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>string_list_append</tt> </dt> <dd> @@ -466,7 +543,7 @@ Append a new string to the end of the string_list. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>sort_string_list</tt> </dt> <dd> @@ -474,22 +551,22 @@ Make an unsorted list sorted. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>unsorted_string_list_has_string</tt> </dt> <dd> <p> - It's like <tt>string_list_has_string()</tt> but for unsorted lists. + It’s like <tt>string_list_has_string()</tt> but for unsorted lists. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>unsorted_string_list_lookup</tt> </dt> <dd> <p> - It's like <tt>string_list_lookup()</tt> but for unsorted lists. + It’s like <tt>string_list_lookup()</tt> but for unsorted lists. </p> -<div class="para"><p>The above two functions need to look through all items, as opposed to their +<div class="paragraph"><p>The above two functions need to look through all items, as opposed to their counterpart for sorted lists, which performs a binary search.</p></div> </dd> </dl></div> @@ -498,24 +575,24 @@ </div> <h2 id="_data_structures">Data structures</h2> <div class="sectionbody"> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct string_list_item</tt> </p> </li> </ul></div> -<div class="para"><p>Represents an item of the list. The <tt>string</tt> member is a pointer to the +<div class="paragraph"><p>Represents an item of the list. The <tt>string</tt> member is a pointer to the string, and you may use the <tt>util</tt> member for any purpose, if you want.</p></div> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>struct string_list</tt> </p> </li> </ul></div> -<div class="para"><p>Represents the list itself.</p></div> -<div class="olist"><ol> +<div class="paragraph"><p>Represents the list itself.</p></div> +<div class="olist arabic"><ol class="arabic"> <li> <p> The array of items are available via the <tt>items</tt> member. @@ -542,7 +619,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:15 UTC +Last updated 2010-07-01 00:08:13 UTC </div> </div> </body> diff --git a/technical/api-tree-walking.html b/technical/api-tree-walking.html index 57dc109..44b19cb 100644 --- a/technical/api-tree-walking.html +++ b/technical/api-tree-walking.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>tree walking API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>tree walking API</title> </head> <body> <div id="header"> @@ -311,13 +388,13 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>The tree walking API is used to traverse and inspect trees.</p></div> +<div class="paragraph"><p>The tree walking API is used to traverse and inspect trees.</p></div> </div> </div> <h2 id="_data_structures">Data Structures</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>struct name_entry</tt> </dt> <dd> @@ -326,7 +403,7 @@ mode. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>struct tree_desc</tt> </dt> <dd> @@ -334,7 +411,7 @@ A semi-opaque data structure used to maintain the current state of the walk. </p> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>buffer</tt> is a pointer into the memory representation of the tree. It always @@ -353,14 +430,14 @@ </li> </ul></div> </dd> -<dt> +<dt class="hdlist1"> <tt>struct traverse_info</tt> </dt> <dd> <p> A structure used to maintain the state of a traversal. </p> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>prev</tt> points to the traverse_info which was used to descend into the @@ -405,8 +482,8 @@ </div> <h2 id="_initializing">Initializing</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>init_tree_desc</tt> </dt> <dd> @@ -416,7 +493,7 @@ members of <tt>struct tree</tt>. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>fill_tree_descriptor</tt> </dt> <dd> @@ -426,7 +503,7 @@ identifier and NULL otherwise. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>setup_traverse_info</tt> </dt> <dd> @@ -441,8 +518,8 @@ </div> <h2 id="_walking">Walking</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>tree_entry</tt> </dt> <dd> @@ -452,17 +529,17 @@ commonly used in the test of a while loop. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>tree_entry_len</tt> </dt> <dd> <p> - Calculate the length of a tree entry's pathname. This utilizes the + Calculate the length of a tree entry’s pathname. This utilizes the memory structure of a tree entry to avoid the overhead of using a generic strlen(). </p> </dd> -<dt> +<dt class="hdlist1"> <tt>update_tree_entry</tt> </dt> <dd> @@ -471,25 +548,25 @@ with <tt>tree_entry_extract</tt> to inspect the current entry. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>tree_entry_extract</tt> </dt> <dd> <p> Decode the entry currently being visited (the one pointed to by - <tt>tree_desc's</tt> <tt>entry</tt> member) and return the sha1 of the entry. The - <tt>pathp</tt> and <tt>modep</tt> arguments are set to the entry's pathname and mode + <tt>tree_desc’s</tt> <tt>entry</tt> member) and return the sha1 of the entry. The + <tt>pathp</tt> and <tt>modep</tt> arguments are set to the entry’s pathname and mode respectively. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>get_tree_entry</tt> </dt> <dd> <p> Find an entry in a tree given a pathname and the sha1 of a tree to search. Returns 0 if the entry is found and -1 otherwise. The third - and fourth parameters are set to the entry's sha1 and mode + and fourth parameters are set to the entry’s sha1 and mode respectively. </p> </dd> @@ -497,8 +574,8 @@ </div> <h2 id="_traversing">Traversing</h2> <div class="sectionbody"> -<div class="vlist"><dl> -<dt> +<div class="dlist"><dl> +<dt class="hdlist1"> <tt>traverse_trees</tt> </dt> <dd> @@ -507,14 +584,14 @@ <tt>traverse_info</tt> is called once for each tree entry. </p> </dd> -<dt> +<dt class="hdlist1"> <tt>traverse_callback_t</tt> </dt> <dd> <p> The arguments passed to the traverse callback are as follows: </p> -<div class="ilist"><ul> +<div class="ulist"><ul> <li> <p> <tt>n</tt> counts the number of trees being traversed. @@ -527,7 +604,7 @@ </li> <li> <p> -<tt>dirmask</tt> has its nth bit set if the nth tree's entry is a directory. +<tt>dirmask</tt> has its nth bit set if the nth tree’s entry is a directory. </p> </li> <li> @@ -541,12 +618,12 @@ </p> </li> </ul></div> -<div class="para"><p>Returning a negative value will terminate the traversal. Otherwise the +<div class="paragraph"><p>Returning a negative value will terminate the traversal. Otherwise the return value is treated as an update mask. If the nth bit is set the nth tree will be updated and if the bit is not set the nth tree entry will be the same in the next callback invocation.</p></div> </dd> -<dt> +<dt class="hdlist1"> <tt>make_traverse_path</tt> </dt> <dd> @@ -557,7 +634,7 @@ tree would be "bar/baz". </p> </dd> -<dt> +<dt class="hdlist1"> <tt>traverse_path_len</tt> </dt> <dd> @@ -571,12 +648,12 @@ </div> <h2 id="_authors">Authors</h2> <div class="sectionbody"> -<div class="para"><p>Written by Junio C Hamano <gitster@pobox.com> and Linus Torvalds -<torvalds@linux-foundation.org></p></div> +<div class="paragraph"><p>Written by Junio C Hamano <<a href="mailto:gitster@pobox.com">gitster@pobox.com</a>> and Linus Torvalds +<<a href="mailto:torvalds@linux-foundation.org">torvalds@linux-foundation.org</a>></p></div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:15 UTC +Last updated 2010-08-22 07:24:51 UTC </div> </div> </body> diff --git a/technical/api-xdiff-interface.html b/technical/api-xdiff-interface.html index 502fac2..082e68c 100644 --- a/technical/api-xdiff-interface.html +++ b/technical/api-xdiff-interface.html
@@ -3,7 +3,8 @@ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> -<meta name="generator" content="AsciiDoc 8.2.5" /> +<meta name="generator" content="AsciiDoc 8.4.5" /> +<title>xdiff interface API</title> <style type="text/css"> /* Debug borders */ p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { @@ -26,10 +27,12 @@ em { font-style: italic; + color: navy; } strong { font-weight: bold; + color: #083194; } tt { @@ -71,6 +74,10 @@ margin-bottom: 0.5em; } +ul, ol, li > p { + margin-top: 0; +} + pre { padding: 0; margin: 0; @@ -84,7 +91,7 @@ } span#email { } -span#revision { +span#revnumber, span#revdate, span#revremark { font-family: sans-serif; } @@ -104,11 +111,13 @@ padding-bottom: 0.5em; } -div#preamble, +div#preamble { + margin-top: 1.5em; + margin-bottom: 1.5em; +} div.tableblock, div.imageblock, div.exampleblock, div.verseblock, div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, div.admonitionblock { - margin-right: 10%; margin-top: 1.5em; margin-bottom: 1.5em; } @@ -123,6 +132,7 @@ /* Block element titles. */ div.title, caption.title { + color: #527bbd; font-family: sans-serif; font-weight: bold; text-align: left; @@ -149,22 +159,33 @@ padding: 0.5em; } -div.listingblock { - margin-right: 0%; -} div.listingblock > div.content { border: 1px solid silver; background: #f4f4f4; padding: 0.5em; } -div.quoteblock > div.content { +div.quoteblock { padding-left: 2.0em; + margin-right: 10%; } - -div.attribution { +div.quoteblock > div.attribution { + padding-top: 0.5em; text-align: right; } + +div.verseblock { + padding-left: 2.0em; + margin-right: 10%; +} +div.verseblock > div.content { + white-space: pre; +} +div.verseblock > div.attribution { + padding-top: 0.75em; + text-align: left; +} +/* DEPRECATED: Pre version 8.2.7 verse style literal block. */ div.verseblock + div.attribution { text-align: left; } @@ -187,13 +208,9 @@ padding: 0.5em; } -div.verseblock div.content { - white-space: pre; -} - div.imageblock div.content { padding-left: 0; } -div.imageblock img { border: 1px solid silver; } span.image img { border-style: none; } +a.image:visited { color: white; } dl { margin-top: 0.8em; @@ -202,18 +219,38 @@ dt { margin-top: 0.5em; margin-bottom: 0; - font-style: italic; + font-style: normal; + color: navy; } dd > *:first-child { - margin-top: 0; + margin-top: 0.1em; } ul, ol { list-style-position: outside; } -div.olist2 ol { +ol.arabic { + list-style-type: decimal; +} +ol.loweralpha { list-style-type: lower-alpha; } +ol.upperalpha { + list-style-type: upper-alpha; +} +ol.lowerroman { + list-style-type: lower-roman; +} +ol.upperroman { + list-style-type: upper-roman; +} + +div.compact ul, div.compact ol, +div.compact p, div.compact p, +div.compact div, div.compact div { + margin-top: 0.1em; + margin-bottom: 0.1em; +} div.tableblock > table { border: 3px solid #527bbd; @@ -225,22 +262,53 @@ tfoot { font-weight: bold; } +td > div.verse { + white-space: pre; +} +p.table { + margin-top: 0; +} +/* Because the table frame attribute is overriden by CSS in most browsers. */ +div.tableblock > table[frame="void"] { + border-style: none; +} +div.tableblock > table[frame="hsides"] { + border-left-style: none; + border-right-style: none; +} +div.tableblock > table[frame="vsides"] { + border-top-style: none; + border-bottom-style: none; +} -div.hlist { + +div.hdlist { margin-top: 0.8em; margin-bottom: 0.8em; } -div.hlist td { - padding-bottom: 5px; +div.hdlist tr { + padding-bottom: 15px; } -td.hlist1 { +dt.hdlist1.strong, td.hdlist1.strong { + font-weight: bold; +} +td.hdlist1 { vertical-align: top; - font-style: italic; + font-style: normal; padding-right: 0.8em; + color: navy; } -td.hlist2 { +td.hdlist2 { vertical-align: top; } +div.hdlist.compact tr { + margin: 0; + padding-bottom: 0; +} + +.comment { + background: yellow; +} @media print { div#footer-badges { display: none; } @@ -279,6 +347,7 @@ padding: 0.5em; } div.sidebar-title, div.image-title { + color: #527bbd; font-family: sans-serif; font-weight: bold; margin-top: 0.0em; @@ -291,8 +360,17 @@ padding: 0.5em; } -div.quoteblock-content { - padding-left: 2.0em; +div.quoteblock-attribution { + padding-top: 0.5em; + text-align: right; +} + +div.verseblock-content { + white-space: pre; +} +div.verseblock-attribution { + padding-top: 0.75em; + text-align: left; } div.exampleblock-content { @@ -303,7 +381,6 @@ /* IE6 sets dynamically generated links as visited. */ div#toc a:visited { color: blue; } </style> -<title>xdiff interface API</title> </head> <body> <div id="header"> @@ -311,14 +388,14 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about our calling convention to xdiff library, including +<div class="paragraph"><p>Talk about our calling convention to xdiff library, including xdiff_emit_consume_fn.</p></div> -<div class="para"><p>(Dscho, JC)</p></div> +<div class="paragraph"><p>(Dscho, JC)</p></div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2010-09-18 23:57:16 UTC +Last updated 2008-09-19 06:28:28 UTC </div> </div> </body> 